home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / path100.zip / BBSNOTES.DOC < prev    next >
Text File  |  1992-07-03  |  16KB  |  359 lines
  1. This document is effective 7/5/92
  2. BBSNOTES
  3.  
  4.  
  5.                  BBS Onliner Interface  version 1.30
  6.                Copyright (C) 1990, 1992 Andrew J. Mead
  7.                          All Rights Reserved.
  8.  
  9.                   Contact:
  10.                        Andrew J. Mead
  11.                        POB 1155
  12.                        Chapel Hill, NC 27514-1155.
  13.                                    or
  14.        1@9952 WWIVnet   1002:735/417 HomeBoyNet   1@9395 VirtualNet
  15.        1:3641/417 FidoNet   75:7919/417 DoorNet   30:507/4 USPolNet
  16.  
  17.                    Sections (in order of appearance)
  18.  
  19.      General info                -  what this file is
  20.  
  21.      Command Line Directives     -  what options to use
  22.          suggested                  /a Again? mode switch
  23.                                     /n Name switch
  24.          suggested                  /q Quiet mode switch
  25.          recommended                /x Hall of Fame Limiting switch
  26.          suggested                  /y Hall of Fame Redirection switch
  27.          suggested                  /z Time Limit switch
  28.                                     /i IRQ/PortAddress Customization switch
  29.                                     /l Force Local Mode switch
  30.                                     /c Communication Port Override switch
  31.          recommended                /b Locked Baud Rate RTS/CTS switch
  32.                                     /k Carrier Detect Override switch
  33.  
  34.      SysOp Control               -  who's playing this game anyway
  35.                                     Current User Line
  36.                                     F-10 SysOp Abort Key
  37.                                     F-9 Line Noise Disconnect Key
  38.  
  39.      Specific BBS Installation
  40.  
  41.      2 A.M. BBS Notes            -  /2  Jumper.Dat installation
  42.      Auntie BBS Notes            -  /7  Auntie.Sys installation
  43.      Force, GAP Notes            -  /S  Door.Sys (long) installation
  44.      Forum Notes                 -  /F  UserInfo.Txt installation
  45.      Genesis Notes               -  /G  CallInfo.BBS installation
  46.      GT, DoorWay Notes           -  /D  Door.Sys (short) installation
  47.      ModuleX Notes               -  /M  Number.Txt installation
  48.      Opus-CBCS 1.13 Notes        -  /3  LastUser.BBS installation
  49.      Opus-CBCS 1.14 Notes        -  /O  LastUsXX.Dat installation
  50.      PCBoard 12.x Notes          -  /1  PCBoard.Sys installation
  51.      PCBoard 14.x Notes          -  /P  PCBoard.Sys installation
  52.      Phoenix Notes               -  /H  Info.BBS installation
  53.      RyBBS Notes                 -  /5  CurrUser.BBS installation
  54.      Sapphire Notes              -  /8  Sapphire.Dat installation
  55.      Search Light Notes          -  /9  Search Light installation
  56.      Spitfire Notes              -  /6  SFDoors.Dat installation
  57.      Telegard                    -  recommend /4 (WWIV emulation)
  58.      WildCat Notes               -  /W  CallInfo.BBS installation
  59.      WWIV Notes                  -  /4  Chain.Txt installation
  60.  
  61.      DorInfo Notes               -  /R# DorInfo#.Def Installation
  62.                                     EIS-PC, FoReM, OLEcom, QuickBBS,
  63.                                     RBBS, Remote Access, TAG, TP-Board
  64.  
  65.  
  66.                            -  General Info  -
  67.  
  68.    This file includes specific notes and examples for most BBS systems
  69.    that this game runs under.  A few basic recomendations:
  70.  
  71.  
  72.                       -  Command Line Directives  -
  73.  
  74.    /a will allow players to play multiple games at one time.  If they have
  75.       more than x minutes left (/a:x), they will be asked if they want to
  76.       play again.  This option carries no recommendation.
  77.      -NOTE: This option does not work with all games (i.e Galactic Empires).
  78.  
  79.    /n this switch is only necessary for use with the /9 SearchLight switch
  80.       or other BBS systems that run the game with command line directives
  81.       instead of using drop files.  It also can be used if you run the
  82.       game locally from DOS.
  83.  
  84.    /q will keep the game from beeping on the host computer.  This enables
  85.       the SysOp to get a good nights sleep.
  86.  
  87.    /x will limit the number of times a player's name will appear on the
  88.       Monthly Hall of Fame.  I recommend /x:2.  This keeps one or two
  89.       good avid players from monopolizing the Hall of Fame.
  90.      -NOTE: This option does not work with all games.
  91.  
  92.    /y I heavily recommend using the text Hall of Fames as bulletins and
  93.       such.  The BBSs in this area that make these files available for the
  94.       users to see tend to have about 5 to 10 times as many players as the
  95.       BBSs that don't.  The ability to look at the top 10 as well as see
  96.       last months top three, and the all time high score tends to highten
  97.       the sense of competition.
  98.      -NOTE: This option is not applicable to all games.
  99.  
  100.    /z sets a maximum time limit.  Normally the game will allow the player
  101.       as much time as he has left to play.  This allows the SysOp to
  102.       encourage players not to fall asleep during games.
  103.  
  104.       The game will execute an inactivity time-out at approximately 2
  105.       minutes.  It will beep at the halfway point and then again when
  106.       it returns control to the BBS.
  107.  
  108.    The game will auto-detect local play, so you can safely play the same
  109.    door locally that the remote users play.
  110.  
  111.    /i allows for customization of your serial communications.  If you are
  112.       using a PS/2 on Com3 or above, or if you are using any non-standard
  113.       IRQ/port address set-up, this option will allow you to get the game
  114.       playing.  This option will not interfere with the game auto-detecting
  115.       local play.  This option (or the /c or /l options) should not be used
  116.       unless absolutely necessary.
  117.  
  118.    NOTE : If you think the game is being forced into local play, check the
  119.    following.  If a remote user is playing the game, the bottom line of the
  120.    host computer will say 'Current User : User's Name or Alias here'.  If
  121.    the line is there, then the game is not locked into local mode.  In local
  122.    mode, the game never displays the 'Current User' line.
  123.  
  124.    /b - Locked BAUD Rate : These programs use RTS handshaking.  If you are
  125.    using a modem with the baud rate locked, then you will want to use this
  126.    switch.  '/B' implements RTS/CTS handshaking, and prevents the game from
  127.    overrunning the modems internal buffer.  This switch is RECOMMENDED
  128.    strongly.
  129.  
  130.    /k turns off the games carrier detect routines.  This option is a 'last
  131.        resort' option.  If your modem does not properly maintain a Carrier
  132.        Detect' signal, the game will automatically abort.  This option
  133.        supresses this activity.  If the user does drop carrier, the game
  134.        will still do an inactivity timeout after 2 minutes.  If you are
  135.        forced to use this option, you probably are having hardware problems
  136.        with the modem or RS-232 connector (bad pin or broken wire).
  137.  
  138.  
  139.                            -  SysOp Control  -
  140.  
  141.    Current User Line - The bottom line (line 25) on the BBSs monitor will
  142.        display the name of the player currently logged on.  This will not
  143.        display if the game is being played locally.
  144.  
  145.    F-10 - SysOp abort.  Pressing this key on the host keyboard will abort
  146.        the game in progress, and return control to the batch file, or BBS.
  147.        The user will be notified that the SysOp has terminated the session.
  148.  
  149.    F-9  - Line Noise.  Pressing this key on the host keyboard will simulate
  150.        line noise, then hang up the phone.  It will appear to the user as
  151.        if the connection was trashed.
  152.  
  153.    F-8  - Give User Time.  Remote player will be given one more minute.
  154.  
  155.    F-7  - Take User Time.  Remote player will lose one minute of game time.
  156.  
  157.  
  158.                           -  2 A.M. BBS Notes  -
  159.  
  160.    - The /2 option reads a 'Jumper.Dat' file.  For actual installation,
  161.      follow the WWIV example.
  162.  
  163.  
  164.                           -  Auntie BBS Notes  -
  165.  
  166.    - This option is currently in the BETA stage.
  167.    - The /7 option reads a 'Auntie.Sys' file.  You will need to include the
  168.      /c or /i directive with this set-up.  Auntie.Sys does not tell which
  169.      communications port is being used.
  170.    For actual installation,
  171.      follow the WWIV example.  If you have documentation on this file, or
  172.      possibly other files that Auntie BBS creates, please let me know.
  173.  
  174.  
  175.                           -  Force, Gap Notes  -
  176.  
  177.    - The /S option reads a 'Door.Sys' file.  This is the new proposed
  178.      standard for doors.  This format is currently used by Force and GAP.
  179.      For actual installation, follow the WWIV example.  If this option
  180.      does not seem to work correctly, you need to be aware that there are
  181.      two different Door.Sys files that BBSes use.  The other one is
  182.      interpreted with the /D switch.  You may need to try it instead.
  183.  
  184.  
  185.                              -  Forum Notes  -
  186.  
  187.    - The /F option reads a 'UserInfo.Txt' file.  For actual installation,
  188.      follow the WWIV example.
  189.  
  190.  
  191.                             -  Genesis Notes  -
  192.  
  193.    - The /G option does not currently work.  I do not have sufficient
  194.      information on Genesis' CallInfo.BBS.  It seems to match WildCat's
  195.      upto line 28.  Line 29 should contain communication port information.
  196.      If it does, use the /W directive instead.  I would really appreciate
  197.      some more complete documentation on Genesis.
  198.  
  199.  
  200.                           -  GT, DoorWay Notes  -
  201.  
  202.    - The /D option reads a 'Door.Sys' file.  This is the same Door.Sys that
  203.      is used by Marshall Dudley's DoorWay to Unlimited Doors Program.
  204.      For actual installation, follow the WWIV example.  If you have troubles
  205.      with this option, you may be using the wrong switch.  There are two
  206.      common Door.Sys files, the other one is /S.  You may want to try it.
  207.  
  208.  
  209.                             -  ModuleX Notes  -
  210.  
  211.    - The /M option reads a 'Number.Txt' file.  For actual installation,
  212.      follow the WWIV example.
  213.  
  214.  
  215.                          -  OPUS-CBCS 1.13 Notes  -
  216.  
  217.    - This option does not currently work.
  218.    - The /3 option reads a 'LastUser.BBS' file.  For actual installation,
  219.      follow the WWIV example.  If you have documentation on this file,
  220.      please let me know.
  221.  
  222.  
  223.                          -  OPUS-CBCS 1.14 Notes  -
  224.  
  225.    - The /OXX option reads a 'LastUsXX.Dat' file.  The 'XX' is the OPUS
  226.      task number; if it is absent the program will attempt to read a file
  227.      called 'LastUser.Dat'.  an example with a task number (hexadecimal)
  228.      of 'e' would be
  229.  
  230.      madness /o0e:c:\opus\   ...
  231.  
  232.      the c:\opus\ tells it to look for 'LastUs0E.Dat' in the C:\OPUS\
  233.      directory.  The '...' is the other command line options (check the
  234.      WWIV example for a more thorough example).
  235.  
  236.  
  237.                           -  PCBoard 12.x Notes  -
  238.  
  239.    - This option is currently in the BETA stage..
  240.    - The /1 option reads a 'PCBoard.Sys' file.  For actual installation,
  241.      follow the WWIV example.  If you have documentation on this file,
  242.      please send it to me.
  243.  
  244.  
  245.                           -  PCBoard 14.x Notes  -
  246.  
  247.    - The /P option reads a 'PCBoard.Sys' file.  For actual installation,
  248.      follow the WWIV example.
  249.  
  250.  
  251.                             -  Phoenix Notes  -
  252.  
  253.    - The /H option reads a 'Info.BBS' file.  For actual installation,
  254.      follow the WWIV example.
  255.  
  256.  
  257.                              -  RyBBS Notes  -
  258.  
  259.    - The /5 option reads a 'CurrUser.BBS' file.  For actual installation,
  260.      follow the WWIV example.
  261.  
  262.  
  263.                             -  Sapphire Notes  -
  264.  
  265.    - This option does not currently work.
  266.    - The /8 option reads a 'Sapphire.Dat' file.  For actual installation,
  267.      follow the WWIV example.  If you have documentation on this file, or
  268.      possibly other files that Sapphire BBS creates, please let me know.
  269.  
  270.  
  271.                           -  Search Light Notes  -
  272.  
  273.    - The /9 option is the reverse of the rest of these BBS switches. Since
  274.      the program is being run directly by SLBBS instead of from a batch file,
  275.      the current directory is the same as the BBS's directory.  /9 will tell
  276.      the game to get the path from the command line.
  277.  
  278.                       c:\slbbs\games\stars\starsbbs /9
  279.  
  280.      This will tell the game to get 'c:\slbbs\games\stars\' from memory.
  281.      You will need to pass more information to make the game run.  I have
  282.      added a /n switch to read the users name.  You should use the %U switch
  283.      so that SearchLight passes the complete name like Andy_Mead.  It
  284.      should look something like /n:%U or /n%U.  The next switch you should
  285.      use is the /z directive to get the user's time remaining.  I believe
  286.      the SL switch is %M, so you should have /z:%M or optionally you can
  287.      set a specific time limit (i.e. /z:20).  The final piece of information
  288.      need is communication port.  My games use /c and SL uses %P.  Therefore
  289.      /c:%P should fit the bill.  A final example (check elsewhere for
  290.      descriptions of /a, /b, /q, and /y) would be
  291.  
  292.  c:\slbbs\games\mad\madness /9 /n:%U /c:%P /z:%M /a:15 /y:c:\slbbs\text\ /q /b
  293.  
  294.      The spaces between switches is mandatory.
  295.  
  296.  
  297.                            -  Spitfire Notes  -
  298.  
  299.    - The /6 option reads a 'SFDoors.Dat' file.  For actual installation,
  300.      follow the WWIV example.
  301.  
  302.  
  303.                             -  WildCat Notes  -
  304.  
  305.    - use the /y command to rename the text hall of fame for your bulletins
  306.      menu.  /y:c:\wildcat\bull34.bbs will rename the Hall of Fame 'Bull34.BBS'
  307.      and place it in the c:\wildcat directory.
  308.  
  309.  
  310.                             -  WWIV Notes  -
  311.  
  312.    - sample WWIV installation (using Star Traders - starsbbs.exe)
  313.      WWIV,chain.txt directory  - C:\WWIV
  314.      batch file                - stars.bat
  315.      stars.bat directory       - C:\WWIV\GAMES
  316.      starsbbs.exe directory    - C:\WWIV\GAMES\STARS
  317.      hall of fames directory   - C:\WWIV\GFILES\HOFSDIR
  318.  
  319.      stars.bat listing
  320.        echo off
  321.        cd c:\wwiv\games\stars
  322.        starsbbs /4:c:\wwiv\ /q /x:2 /z:20 /a /b /y:c:\wwiv\gfiles\hofsdir\
  323.        cd c:\wwiv
  324.  
  325.      chainedit setting
  326.        file - c:\wwiv\games\stars.bat
  327.        dos interrupts - off, this game handles it's own communications
  328.        shrink - doesn't matter - recommend NO
  329.        ansi - required
  330.        allow 300 bps users - recommend NO
  331.  
  332.    - If you are NOT using WWIV then substitute your BBSs switch for '/4'.
  333.  
  334.    - In WWIV mode, the current user line will also display user's
  335.      number and real name.
  336.  
  337.  
  338.                           -  DoorInfo Notes  -
  339.  
  340.    - EIS-PC, FoReM, Professional OLEcom, QuickBBS, RBBS, Remote Access,
  341.      TAG, TP-Board, and many more.
  342.    - If you use RBBS (or another DorInfo generating BBS), you will need
  343.      to let the program know what node the program is on.  If you use
  344.      /R by itself, the program will look for a file called DoorInfo.Def.
  345.      /R1 will look for DorInfo1.Def, /R2 will look for DorInfo2.Def, etc...
  346.  
  347.      A sample command line for node 1 (using OilField.exe) would be
  348.      oilfield /r1:c:\rbbs\ /b /x:2 /z:35 /y:c:\rbbs\bulletn\ /q /a:25
  349.  
  350.      where the program looks for DorInfo1.Def in c:\rbbs and when the
  351.      game is over it places OilHOF.Txt in c:\rbbs\bulletn
  352.  
  353.  
  354.                          BBS Onliner Interface
  355.      Copyright (C) 1990, 1992 Andrew J. Mead - All Rights Reserved.
  356.               The Mad Programmer - Brown & Mead Consulting
  357.                   POB 1155 Chapel Hill, NC 27514-1155
  358.  
  359. END BBSNOTES.DOC